Package-level declarations

Types

class AbortController(logger: Logger = NoopLogger)

Mutable abort source — the v6 equivalent of AbortController. Hold the controller, hand the signal to the agent, call abort from the UI's stop button.

AbortError

class AbortError(message: String = "operation aborted") : CancellationException

Thrown from AbortSignal.throwIfAborted when the signal has fired.

AbortSignal

interface AbortSignal

AbortSignals

object AbortSignals

Member-extensions converting coroutine handles into AbortSignals.

Agent

interface Agent<TContext, TOutput>

AgentError

sealed class AgentError : AiSdkException

AgentEvent

sealed class AgentEvent

AgentSession

class AgentSession<TContext, TOutput>(scope: CoroutineScope, agent: Agent<TContext, TOutput>, initialMessages: List<ModelMessage> = emptyList())

AgentSessions

object AgentSessions

AgentSessionState

data class AgentSessionState<TOutput>(val messages: List<ModelMessage> = emptyList(), val status: AgentSessionStatus = AgentSessionStatus.Ready, val text: String = "", val output: TOutput? = null, val pendingApprovals: List<PendingApproval> = emptyList(), val lastResult: GenerateResult<TOutput>? = null, val error: Throwable? = null)

AgentSessionStatus

enum AgentSessionStatus : Enum<AgentSessionStatus>

AgentSettings

class AgentSettings<TContext>

Returned from prepareCall. Any non-null field overrides the agent default for this invocation only.

AgentSettingsBuilder

class AgentSettingsBuilder<TContext>

AiSdkDsl

@DslMarker

annotation class AiSdkDsl

Marks AI SDK builder receivers so nested DSL blocks do not leak outer scopes.

AiSdkException

sealed class AiSdkException : RuntimeException

APICallError

class APICallError(message: String, val url: String, val requestBodyValues: JsonElement? = null, val statusCode: Int? = null, val responseHeaders: Map<String, String>? = null, val responseBody: String? = null, cause: Throwable? = null, val isRetryable: Boolean = statusCode == 408 || statusCode == 409 || statusCode == 429 || (statusCode ?: 0) >= 500) : AiSdkException

Provider HTTP/API failure with normalized request and response details.

value class ApprovalId(val value: String)

ApprovalIds

object ApprovalIds

Approval-identity helpers for PendingApproval.

AudioSource

data class AudioSource(val mediaType: String, val base64: String, val filename: String? = null)

AuthOptions

class AuthOptions

AuthOptionsBuilder

class AuthOptionsBuilder

AuthorizationServerMetadata

@Serializable

class AuthorizationServerMetadata(val issuer: String? = null, val authorizationEndpoint: String? = null, val tokenEndpoint: String? = null, val registrationEndpoint: String? = null, val responseTypesSupported: List<String>? = null, val grantTypesSupported: List<String>? = null, val tokenEndpointAuthMethodsSupported: List<String>? = null, val codeChallengeMethodsSupported: List<String>? = null)

AuthResult

enum AuthResult : Enum<AuthResult>

CallCompletionApiOptions

class CallCompletionApiOptions

CallCompletionApiOptionsBuilder

class CallCompletionApiOptionsBuilder

CallConfig

class CallConfig

CallConfigBuilder

class CallConfigBuilder

CallSettings

class CallSettings

CallSettingsBuilder

class CallSettingsBuilder

CallTimeoutError

class CallTimeoutError(val timeout: Duration, message: String = "Call timed out after ") : AiSdkException

CallToolResult

@Serializable

class CallToolResult(val content: List<JsonObject> = emptyList(), val structuredContent: JsonElement? = null, val isError: Boolean = false, val toolResult: JsonElement? = null, val meta: JsonObject? = null)

CallWarning

@Serializable

class CallWarning(val type: String, val message: String? = null, val details: JsonElement? = null)

Provider warning for a call that still completed. Mirrors v6's CallWarning shape without baking provider-specific warning enums into common code.

ChunkBy

sealed class ChunkBy

ClientAuthResult

class ClientAuthResult(val additionalHeaders: Map<String, String> = emptyMap(), val additionalParams: Map<String, String> = emptyMap())

Completion

class Completion(options: UseCompletionOptions = UseCompletionOptions(block = {}))

CompletionApi

object CompletionApi

CompletionPhase

sealed class CompletionPhase

CompletionRequest

class CompletionRequest

CompletionRequestBuilder

class CompletionRequestBuilder

CompletionRequestOptions

class CompletionRequestOptions

CompletionRequestOptionsBuilder

class CompletionRequestOptionsBuilder

CompletionState

data class CompletionState(val input: String = "", val phase: CompletionPhase = CompletionPhase.Idle)

CompletionStreamProtocol

enum CompletionStreamProtocol : Enum<CompletionStreamProtocol>

CompletionTransport

interface CompletionTransport

Configuration

@Serializable

class Configuration

ConfigurationBuilder

class ConfigurationBuilder

ContentPart

@Serializable

sealed class ContentPart

Content part of a ModelMessage. Sealed so consumers exhaust over variants — adding a new content type forces a compile error at every dispatch site.

CustomProvider

class CustomProvider : Provider

CustomProviderBuilder

class CustomProviderBuilder

DataUrl

data class DataUrl(val mediaType: String, val base64: String)

DeepPartial

class DeepPartial<T>(val value: T?)

DefaultGeneratedFile

class DefaultGeneratedFile

DefaultRedactor

class DefaultRedactor(options: RedactionOptions = RedactionOptions {}) : Redactor

DevToolsRecorder

interface DevToolsRecorder

DevToolsStep

class DevToolsStep(val id: String, val runId: String, val stepNumber: Int, val type: String, val modelId: String, val provider: String, val input: JsonElement, val providerOptions: ProviderOptions)

DevToolsStepResult

class DevToolsStepResult(val durationMs: Long, val output: JsonElement?, val usage: Usage?, val error: String?, val rawRequest: JsonElement? = null, val rawResponse: JsonElement? = null, val rawChunks: List<JsonElement> = emptyList())

DownloadedAsset

class DownloadedAsset(val base64: String, val mediaType: String?)

The base64 bytes + media type of a downloaded asset.

DownloadError

class DownloadError(val url: String, message: String, val statusCode: Int? = null, val statusText: String? = null, cause: Throwable? = null) : AiSdkException

DownloadFunction

typealias DownloadFunction = suspend (url: String) -> DownloadedAsset

Downloads a remote asset for PromptConversion.convertToLanguageModelPrompt.

ElicitationCapability

@Serializable

class ElicitationCapability

ElicitationCapabilityBuilder

class ElicitationCapabilityBuilder

ElicitationRequest

@Serializable

data class ElicitationRequest(val params: ElicitationRequestParams, val method: String = "elicitation/create")

ElicitationRequestParams

@Serializable

data class ElicitationRequestParams(val message: String, val requestedSchema: JsonElement, val meta: JsonObject? = null)

ElicitationRequestSchema

object ElicitationRequestSchema

ElicitResult

@Serializable

class ElicitResult(val action: String, val content: JsonObject? = null, val meta: JsonObject? = null)

ElicitResultSchema

object ElicitResultSchema

Embedding

object Embedding

EmbeddingMath

object EmbeddingMath

EmbeddingMiddlewareCallContext

class EmbeddingMiddlewareCallContext(val params: EmbeddingModelCallParams, val model: EmbeddingModel, val doEmbed: suspend (EmbeddingModelCallParams) -> EmbeddingModelResult)

EmbeddingModel

interface EmbeddingModel

EmbeddingModelCallParams

class EmbeddingModelCallParams

EmbeddingModelCallParamsBuilder

class EmbeddingModelCallParamsBuilder

EmbeddingModelMiddleware

interface EmbeddingModelMiddleware

EmbeddingModelResult

class EmbeddingModelResult(val embeddings: List<List<Float>>, val usage: EmbeddingUsage = EmbeddingUsage(), val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

EmbeddingUsage

class EmbeddingUsage(val tokens: Int = 0, val raw: JsonElement? = null)

EmbedManyResult

class EmbedManyResult<TValue>(val values: List<TValue>, val embeddings: List<List<Float>>, val usage: EmbeddingUsage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val responses: List<LanguageModelResponseMetadata> = emptyList(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

EmbedResult

class EmbedResult<TValue>(val value: TValue, val embedding: List<Float>, val usage: EmbeddingUsage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

EmptyResponseBodyError

class EmptyResponseBodyError(message: String = "Empty response body") : AiSdkException

ExecuteToolResult

sealed class ExecuteToolResult<out TOutput>

Experimental_GeneratedImage

typealias Experimental_GeneratedImage = GeneratedFile

Experimental_GenerateImageResult

typealias Experimental_GenerateImageResult = GenerateImageResult

experimental_MCPClient

typealias experimental_MCPClient = MCPClient

experimental_MCPClientCapabilities

typealias experimental_MCPClientCapabilities = MCPClientCapabilities

experimental_MCPClientConfig

typealias experimental_MCPClientConfig = MCPClientConfig

Experimental_SpeechResult

typealias Experimental_SpeechResult = GenerateSpeechResult

Experimental_StdioMCPTransport

class Experimental_StdioMCPTransport(val config: StdioConfig, engineContext: CoroutineContext = Dispatchers.Default) : MCPTransport

Experimental_TranscriptionResult

typealias Experimental_TranscriptionResult = TranscribeResult

ExperimentalAiSdkApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an experimental AI SDK API. It may change or be removed without notice. Opt in with @OptIn(ExperimentalAiSdkApi::class).")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalAiSdkApi

Marks a declaration as experimental: a surface whose shape may change or be removed in any release without going through the normal deprecation cycle.

FileData

sealed class FileData

FinishReason

@Serializable

enum FinishReason : Enum<FinishReason>

Why a generation step ended.

GatewayAuthenticationError

class GatewayAuthenticationError(message: String = "Authentication failed", statusCode: Int = 401, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayAuthMethod

enum GatewayAuthMethod : Enum<GatewayAuthMethod>

GatewayAuthToken

data class GatewayAuthToken(val token: String, val authMethod: GatewayAuthMethod)

GatewayCredentialType

enum GatewayCredentialType : Enum<GatewayCredentialType>

GatewayCreditsResponse

class GatewayCreditsResponse(val balance: String, val totalUsed: String)

GatewayError

open class GatewayError(message: String, val statusCode: Int = 500, val type: String = "gateway_error", val generationId: String? = null, cause: Throwable? = null, val isRetryable: Boolean = statusCode == 408 || statusCode == 409 || statusCode == 429 || statusCode >= 500) : AiSdkException

GatewayFetchMetadataResponse

class GatewayFetchMetadataResponse(val models: List<GatewayLanguageModelEntry>)

GatewayGenerationInfo

class GatewayGenerationInfo(val id: String, val totalCost: Double, val upstreamInferenceCost: Double, val usage: Double, val createdAt: String, val model: String, val isByok: Boolean, val providerName: String, val streamed: Boolean, val finishReason: String, val latency: Int, val generationTime: Int, val promptTokens: Int, val completionTokens: Int, val reasoningTokens: Int, val cachedTokens: Int, val cacheCreationTokens: Int, val billableWebSearchCalls: Int)

GatewayGenerationInfoParams

class GatewayGenerationInfoParams

GatewayGenerationInfoParamsBuilder

class GatewayGenerationInfoParamsBuilder

GatewayInternalServerError

class GatewayInternalServerError(message: String = "Internal server error", statusCode: Int = 500, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayInvalidRequestError

class GatewayInvalidRequestError(message: String = "Invalid request", statusCode: Int = 400, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayLanguageModelEntry

class GatewayLanguageModelEntry(val id: String, val name: String, val description: String? = null, val pricing: GatewayPricing? = null, val specification: GatewayLanguageModelSpecification, val modelType: GatewayModelType? = null)

GatewayLanguageModelSpecification

class GatewayLanguageModelSpecification(val specificationVersion: String = "v3", val provider: String, val modelId: String)

GatewayModelEntry

typealias GatewayModelEntry = GatewayLanguageModelEntry

GatewayModelNotFoundError

class GatewayModelNotFoundError(message: String = "Model not found", statusCode: Int = 404, val modelId: String? = null, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayModelType

enum GatewayModelType : Enum<GatewayModelType>

GatewayPricing

class GatewayPricing(val input: String, val output: String, val cachedInputTokens: String? = null, val cacheCreationInputTokens: String? = null)

GatewayProvider

interface GatewayProvider : Provider

GatewayProviderSettings

class GatewayProviderSettings

GatewayProviderSettingsBuilder

class GatewayProviderSettingsBuilder

GatewayRateLimitError

class GatewayRateLimitError(message: String = "Rate limit exceeded", statusCode: Int = 429, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayRequestContext

class GatewayRequestContext(val baseUrl: String, val headers: Map<String, String>)

GatewayResponseError

class GatewayResponseError(message: String = "Invalid response from Gateway", statusCode: Int = 502, val response: JsonElement? = null, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewaySpendReportDatePart

enum GatewaySpendReportDatePart : Enum<GatewaySpendReportDatePart>

GatewaySpendReportGroupBy

enum GatewaySpendReportGroupBy : Enum<GatewaySpendReportGroupBy>

GatewaySpendReportParams

class GatewaySpendReportParams

GatewaySpendReportParamsBuilder

class GatewaySpendReportParamsBuilder

GatewaySpendReportResponse

class GatewaySpendReportResponse(val results: List<GatewaySpendReportRow>)

GatewaySpendReportRow

class GatewaySpendReportRow(val day: String? = null, val hour: String? = null, val user: String? = null, val model: String? = null, val tag: String? = null, val provider: String? = null, val credentialType: GatewayCredentialType? = null, val totalCost: Double, val marketCost: Double? = null, val inputTokens: Int? = null, val outputTokens: Int? = null, val cachedInputTokens: Int? = null, val cacheCreationInputTokens: Int? = null, val reasoningTokens: Int? = null, val requestCount: Int? = null)

GatewayTimeoutError

class GatewayTimeoutError(message: String = "Gateway request timed out", statusCode: Int = 408, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayTools

class GatewayTools(val parallelSearch: Tool<JsonElement, JsonElement, Any?> = ProviderExecutedTool( name = "parallelSearch", description = "Search the web using Parallel AI's Search API for LLM-optimized excerpts.", inputSerializer = JsonElement.serializer(), outputSerializer = JsonElement.serializer(), ), val perplexitySearch: Tool<JsonElement, JsonElement, Any?> = ProviderExecutedTool( name = "perplexitySearch", description = "Search the web using Perplexity's Search API for real-time information.", inputSerializer = JsonElement.serializer(), outputSerializer = JsonElement.serializer(), ))

GatewayTransport

interface GatewayTransport

GatewayTransportNotConfigured

data object GatewayTransportNotConfigured : GatewayTransport

GatewayTransportNotConfiguredError

class GatewayTransportNotConfiguredError : AiSdkException

GeneratedAudioFile

typealias GeneratedAudioFile = GeneratedFile

GeneratedFile

class GeneratedFile(val mediaType: String, val base64: String, val filename: String? = null, val providerMetadata: ProviderMetadata = ProviderMetadata.None, val url: String? = null)

GeneratedFiles

object GeneratedFiles

GeneratedFile read accessors as member-extensions. Use via member-import (import ai.torad.aisdk.GeneratedFiles.bytes) or with(GeneratedFiles) { ... }.

GenerateImageResult

class GenerateImageResult(val images: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val responses: List<LanguageModelResponseMetadata> = listOf(response), val usage: ImageModelUsage = ImageModelUsage())

GenerateObjectResult

class GenerateObjectResult<TOutput>(val value: TOutput, val text: String, val reasoning: String? = null, val finishReason: FinishReason, val usage: Usage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

GenerateResult

class GenerateResult<TOutput>

Final output of Agent.generate. When pendingApprovals is non-empty, the loop paused on tool approval — call Agent.generate again with messages plus tool-approval-response messages to resume.

GenerateSpeechResult

class GenerateSpeechResult(val audio: GeneratedFile, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val responses: List<LanguageModelResponseMetadata> = listOf(response))

GenerateTextResult

class GenerateTextResult<TOutput>

GenerateVideoResult

class GenerateVideoResult(val videos: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val responses: List<LanguageModelResponseMetadata> = listOf(response))

GenerationInput

sealed class GenerationInput

Prompt material accepted by high-level generators.

GetPromptResult

@Serializable

class GetPromptResult(val messages: List<MCPPromptMessage>, val description: String? = null, val meta: JsonObject? = null)

HttpMCPTransport

class HttpMCPTransport(client: HttpClient, url: String, headers: Map<String, String> = emptyMap(), authProvider: OAuthClientProvider? = null, engineContext: CoroutineContext = Dispatchers.Default, reconnectionOptions: MCPReconnectionOptions = MCPReconnectionOptions {}) : MCPTransport

IdGenerator

class IdGenerator

IdGeneratorBuilder

class IdGeneratorBuilder

ImageGeneration

object ImageGeneration

ImageGenerationFile

class ImageGenerationFile(val mediaType: String? = null, val base64: String? = null, val url: String? = null, val filename: String? = null)

ImageGenerationParams

class ImageGenerationParams

ImageGenerationParamsBuilder

class ImageGenerationParamsBuilder

ImageMiddlewareCallContext

class ImageMiddlewareCallContext(val params: ImageGenerationParams, val model: ImageModel, val doGenerate: suspend (ImageGenerationParams) -> ImageModelResult)

ImageModel

interface ImageModel

ImageModelMiddleware

interface ImageModelMiddleware

ImageModelResult

class ImageModelResult(val images: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val usage: ImageModelUsage = ImageModelUsage())

ImageModelUsage

class ImageModelUsage(val inputTokens: Int? = null, val outputTokens: Int? = null, val totalTokens: Int? = null)

Token usage reported by an image model, when available. Mirrors v6's ImageModelUsage.

InitializeResult

@Serializable

class InitializeResult(val protocolVersion: String, val capabilities: MCPServerCapabilities = MCPServerCapabilities(), val serverInfo: Configuration, val instructions: String? = null, val meta: JsonObject? = null)

InMemoryDevToolsRecorder

class InMemoryDevToolsRecorder : DevToolsRecorder

InMemoryTelemetryTracer

class InMemoryTelemetryTracer : TelemetryTracer

InternalAiSdkApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal AI SDK API and is not part of the public contract. It may change or be removed without notice. Opt in with @OptIn(InternalAiSdkApi::class).")

annotation class InternalAiSdkApi

Marks a declaration as internal to the AI SDK implementation: visible across module boundaries for technical reasons (KMP source sets, inlining), but not part of the supported public contract. It may change or be removed at any time.

InvalidArgumentError

class InvalidArgumentError(val argument: String, reason: String, cause: Throwable? = null) : AiSdkException

InvalidDataContentError

class InvalidDataContentError(val content: String?, cause: Throwable? = null, message: String = "Invalid data content. Expected a base64 string, ByteArray, or platform byte buffer, " + "but got ${content ?: "null"}.") : AiSdkException

InvalidMessageRoleError

class InvalidMessageRoleError(val role: String, message: String = "Invalid message role: '") : AiSdkException

InvalidPromptError

class InvalidPromptError(val prompt: String?, message: String, cause: Throwable? = null) : AiSdkException

InvalidResponseDataError

class InvalidResponseDataError(val data: JsonElement?, message: String = "Invalid response data: ") : AiSdkException

InvalidStreamPartError

class InvalidStreamPartError(val chunk: String?, message: String) : AiSdkException

InvalidToolApprovalError

class InvalidToolApprovalError(val approvalId: String) : AiSdkException

InvalidToolInputError

class InvalidToolInputError(val toolInput: String, val toolName: String, cause: Throwable, message: String = "Invalid input for tool ") : AiSdkException

JsonInstruction

object JsonInstruction

JSON-mode instruction injection operations.

JSONParseError

class JSONParseError(val text: String, cause: Throwable) : AiSdkException

JSONRPCError

@Serializable

data class JSONRPCError(val id: JsonElement, val error: JSONRPCErrorData, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCErrorData

@Serializable

data class JSONRPCErrorData(val code: Int, val message: String, val data: JsonElement? = null)

JSONRPCMessage

@Serializable

sealed interface JSONRPCMessage

JSONRPCNotification

@Serializable

data class JSONRPCNotification(val method: String, val params: JsonObject? = null, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCRequest

@Serializable

data class JSONRPCRequest(val id: JsonElement, val method: String, val params: JsonObject? = null, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCResponse

@Serializable

data class JSONRPCResponse(val id: JsonElement, val result: JsonElement? = JsonObject(emptyMap()), val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

KtorGatewayTransport

class KtorGatewayTransport(client: HttpClient, json: Json = aiSdkJson) : GatewayTransport

LanguageModel

interface LanguageModel

LanguageModelCallParams

class LanguageModelCallParams

Single parameter envelope for both generate and stream so middleware can wrap both the same way and wrapLanguageModel only needs one pass-through shape.

LanguageModelCallParamsBuilder

class LanguageModelCallParamsBuilder

LanguageModelMiddleware

interface LanguageModelMiddleware

LanguageModelRequestMetadata

class LanguageModelRequestMetadata(val body: JsonElement? = null)

Request metadata recorded by HTTP-backed or gateway providers.

LanguageModelResponseMetadata

class LanguageModelResponseMetadata(val id: String? = null, val timestampMillis: Long? = null, val modelId: String? = null, val headers: Map<String, String> = emptyMap(), val body: JsonElement? = null)

Response metadata recorded by HTTP-backed or gateway providers.

LanguageModelResult

class LanguageModelResult(val text: String, val toolCalls: List<ContentPart.ToolCall> = emptyList(), val finishReason: FinishReason, val usage: Usage, val providerMetadata: ProviderMetadata = ProviderMetadata.None, val content: List<ContentPart> = buildList { if (text.isNotEmpty()) add(ContentPart.Text(text)) addAll(toolCalls) }, val rawFinishReason: String? = null, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

One-shot generate result.

LanguageModelStreamResult

class LanguageModelStreamResult(val stream: Flow<StreamEvent>, val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

Provider stream plus request/response metadata known before collection.

LanguageModelTool

class LanguageModelTool(val name: String, val description: String, val parametersSchemaJson: String, val providerExecuted: Boolean = false, val metadata: Map<String, JsonElement> = emptyMap(), val strict: Boolean? = null, val providerOptions: ProviderOptions = ProviderOptions.None)

Tool advertisement at the model surface — the JSON-schema shape the provider needs. Distinct from the application-side Tool which carries a Kotlin executor; this is the wire shape that crosses into a provider.

LazySchema

class LazySchema<T>(createSchema: () -> Schema<T>)

ListPromptsResult

@Serializable

class ListPromptsResult(val prompts: List<MCPPrompt>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListResourcesResult

@Serializable

class ListResourcesResult(val resources: List<MCPResource>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListResourceTemplatesResult

@Serializable

class ListResourceTemplatesResult(val resourceTemplates: List<MCPResourceTemplate>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListToolsResult

@Serializable

class ListToolsResult(val tools: List<MCPToolDefinition>, val nextCursor: String? = null, val meta: JsonObject? = null)

LoadAPIKeyError

class LoadAPIKeyError(message: String) : AiSdkException

LoadSettingError

class LoadSettingError(message: String) : AiSdkException

Logger

interface Logger

LoopState

class LoopState(val stepNumber: Int, val totalSteps: Int, val lastFinishReason: FinishReason, val toolCallsThisStep: List<ContentPart.ToolCall>, val toolCallsAllSteps: List<ContentPart.ToolCall>, val steps: List<StepResult> = emptyList())

LoopTermination

object LoopTermination

Loop-termination checks for the tool loop.

LowLevelLanguageModelApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "Direct LanguageModel execution is a low-level provider API. Use Agent.generate/Agent.stream or a high-level SDK API for application prompts, or opt in with @OptIn(LowLevelLanguageModelApi::class).")

annotation class LowLevelLanguageModelApi

Marks direct LanguageModel execution as low-level provider access.

MCPBaseParams

@Serializable

data class MCPBaseParams(val meta: JsonObject? = null)

MCPClient

interface MCPClient

MCPClientCapabilities

@Serializable

class MCPClientCapabilities(val elicitation: ElicitationCapability? = null, val experimental: JsonObject? = null)

MCPClientConfig

class MCPClientConfig

MCPClientConfigBuilder

class MCPClientConfigBuilder

MCPClientError

class MCPClientError(message: String, val code: Int? = null, val data: JsonElement? = null, cause: Throwable? = null) : AiSdkException

MCPPrompt

@Serializable

class MCPPrompt(val name: String, val title: String? = null, val description: String? = null, val arguments: List<MCPPromptArgument>? = null)

MCPPromptArgument

@Serializable

class MCPPromptArgument(val name: String, val description: String? = null, val required: Boolean? = null)

MCPPromptMessage

@Serializable

class MCPPromptMessage(val role: String, val content: JsonObject)

MCPReconnectionOptions

class MCPReconnectionOptions

MCPReconnectionOptionsBuilder

class MCPReconnectionOptionsBuilder

MCPRequestOptions

class MCPRequestOptions

MCPRequestOptionsBuilder

class MCPRequestOptionsBuilder

MCPResource

@Serializable

class MCPResource(val uri: String, val name: String, val title: String? = null, val description: String? = null, val mimeType: String? = null, val size: Long? = null)

MCPResourceTemplate

@Serializable

class MCPResourceTemplate(val uriTemplate: String, val name: String, val title: String? = null, val description: String? = null, val mimeType: String? = null)

MCPServerCapabilities

@Serializable

class MCPServerCapabilities(val experimental: JsonObject? = null, val logging: JsonObject? = null, val prompts: JsonObject? = null, val resources: JsonObject? = null, val tools: JsonObject? = null, val elicitation: ElicitationCapability? = null)

MCPToolDefinition

@Serializable

class MCPToolDefinition(val name: String, val title: String? = null, val description: String? = null, val inputSchema: JsonObject = JsonObject(mapOf("type" to JsonPrimitive("object"))), val outputSchema: JsonObject? = null, val annotations: JsonObject? = null, val meta: JsonObject? = null)

MCPToolSchema

@Serializable

class MCPToolSchema(val inputSchema: JsonElement, val outputSchema: JsonElement? = null)

MCPToolSchemas

typealias MCPToolSchemas = Map<String, MCPToolSchema>

MCPTransport

interface MCPTransport

Transport interface for MCP communication. Implementations may wrap stdio, Streamable HTTP, SSE, WebSockets, or a test fixture.

MCPTransportConfig

class MCPTransportConfig

MCPTransportConfigBuilder

class MCPTransportConfigBuilder

MCPTransportKind

enum MCPTransportKind : Enum<MCPTransportKind>

MessageConversionError

class MessageConversionError(val originalMessage: String?, message: String) : AiSdkException

MessagePruning

object MessagePruning

MessageRole

@Serializable

enum MessageRole : Enum<MessageRole>

MiddlewareCallContext

class MiddlewareCallContext(val params: LanguageModelCallParams, val model: LanguageModel, val doGenerate: suspend (LanguageModelCallParams) -> LanguageModelResult, val doStream: (LanguageModelCallParams) -> Flow<StreamEvent>)

What a middleware receives. Contains:

MiddlewareOperation

enum MiddlewareOperation : Enum<MiddlewareOperation>

Which operation a LanguageModelMiddleware.transformParams call is transforming.

MissingToolResultsError

class MissingToolResultsError(val toolCallIds: List<String>) : AiSdkException

ModelId

@JvmInline

@JvmExposeBoxed

value class ModelId(val value: String)

ModelIdentifiers

object ModelIdentifiers

Factory helpers for the value-class identifiers. These cannot be expressed as PascalCase faux-constructors because a same-signature fun ProviderId(String) / fun ModelId(String) would conflict with the value-class primary constructors, so they live as members of this object.

ModelMessage

@Serializable

class ModelMessage(val role: MessageRole, val content: List<ContentPart>)

v6 wire-shape message — the type passed to LanguageModel generations. Renamed from CoreMessage (v5) per the AI SDK v6 migration.

ModelRef

data class ModelRef(val modelId: ModelId, val providerId: ProviderId? = null)

MutableTelemetrySpan

class MutableTelemetrySpan(val name: String, initialAttributes: Map<String, JsonElement> = emptyMap()) : TelemetryActiveSpan

NoContentGeneratedError

class NoContentGeneratedError(message: String = "No content generated.") : AiSdkException

NoImageGeneratedError

class NoImageGeneratedError(message: String = "No image generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoObjectGeneratedError

class NoObjectGeneratedError(message: String = "No object generated", val text: String? = null, val response: LanguageModelResponseMetadata? = null, val usage: Usage? = null, val finishReason: FinishReason? = null, cause: Throwable? = null) : AiSdkException

NoopLogger

data object NoopLogger : Logger

Drop-everything logger. Default when no DI-injected impl is wired.

NoopTelemetryTracer

data object NoopTelemetryTracer : TelemetryTracer

NoopToolStreamWriter

data object NoopToolStreamWriter : ToolStreamWriter

NoOutputGeneratedError

class NoOutputGeneratedError(message: String = "No output generated") : AiSdkException

NoSpeechGeneratedError

class NoSpeechGeneratedError(message: String = "No speech generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoSuchModelError

class NoSuchModelError(providerId: String?, modelType: String, modelId: String, message: String = buildString { append("No ") append(modelType) append(" model registered for `") providerId?.let { append(it).append(":") } append(modelId) append("`") }) : AiSdkException

NoSuchProviderError

class NoSuchProviderError(val providerId: String, val availableProviders: List<String> = emptyList()) : AiSdkException

NoSuchToolError

class NoSuchToolError(val toolName: String, val availableTools: List<String>? = null, message: String = "Model tried to call unavailable tool '$toolName'. " + if (availableTools == null) { "No tools are available." } else { "Available tools: ${availableTools.joinToString(", ")}." }) : AiSdkException

NoTranscriptGeneratedError

class NoTranscriptGeneratedError(message: String = "No transcript generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoVideoGeneratedError

class NoVideoGeneratedError(message: String = "No video generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

OAuthClientInformation

@Serializable

class OAuthClientInformation

OAuthClientInformationBuilder

class OAuthClientInformationBuilder

OAuthClientMetadata

@Serializable

class OAuthClientMetadata

OAuthClientMetadataBuilder

class OAuthClientMetadataBuilder

OAuthClientProvider

interface OAuthClientProvider

OAuthProtectedResourceMetadata

@Serializable

class OAuthProtectedResourceMetadata(val resource: String, val authorizationServers: List<String>? = null, val jwksUri: String? = null, val scopesSupported: List<String>? = null, val bearerMethodsSupported: List<String>? = null, val resourceName: String? = null)

OAuthTokens

@Serializable

class OAuthTokens(val accessToken: String, val tokenType: String, val idToken: String? = null, val expiresIn: Long? = null, val scope: String? = null, val refreshToken: String? = null)

Output

sealed class Output<T>

ParseResult

sealed class ParseResult<out T>

PartialJson

object PartialJson

Streaming-safe partial-JSON repair + parse operations. Grouped into an object so the helpers stay file-local members rather than loose top-level functions.

PartialJsonResult

class PartialJsonResult(val value: JsonElement?, val state: PartialJsonState)

Result of PartialJson.parsePartialJson: value is non-null only on the two

PartialJsonState

enum PartialJsonState : Enum<PartialJsonState>

Outcome of PartialJson.parsePartialJson, mirroring v6's four state strings.

PendingApproval

@Serializable

class PendingApproval(val toolCallId: String, val toolName: String, val input: JsonElement, val approvalId: String? = null, val signature: String? = null)

A pending tool-call approval surfaced from Agent.generate / Agent.stream. Per v6 RPC semantics, generation completes when one or more tools require approval — the host inspects GenerateResult.pendingApprovals, presents UI, and resumes by calling Agent.generate again with messages = result.messages + ToolApprovalResponseMessage(...).

PrepareCallScope

class PrepareCallScope<TContext>(val options: TContext?, val instructions: String, val model: LanguageModel, val tools: ToolSet<TContext>)

Scope for prepareCall, run once before the loop starts. Useful for RAG context injection, per-user customization, database lookups that shouldn't repeat per step.

PrepareStepScope

class PrepareStepScope<TContext>(val stepNumber: Int, val model: LanguageModel, val steps: List<StepResult>, val messages: List<ModelMessage>, val context: TContext?)

Scope for prepareStep, run before every step in the loop. Used for: model routing per step (cheap model for step 1 + 2, expensive for step 3), tool gating per step (only the search tool is callable on step 1), dynamic system prompts, message compression.

PromptConversion

object PromptConversion

Resolves a prompt for a specific model — the port of upstream's convertToLanguageModelPrompt. Grouped as object members because top-level loose functions are disallowed in this codebase; behavior is identical to the prior free-function form.

interface Provider

value class ProviderId(val value: String)

ProviderMetadata

@Serializable(with = ProviderMetadataSerializer::class)

sealed class ProviderMetadata

ProviderMiddleware

class ProviderMiddleware

ProviderMiddlewareBuilder

class ProviderMiddlewareBuilder

ProviderModels

object ProviderModels

Typed, value-class- and ModelRef-aware accessors over Provider. These are member-extensions: callers reach them via member import or with(ProviderModels) { ... }.

ProviderOptions

sealed class ProviderOptions

Typed provider-options boundary (tenet T2).

ProviderOptionsBuilder

class ProviderOptionsBuilder

ProviderOptionsDsl

object ProviderOptionsDsl

ProviderRegistry

class ProviderRegistry(providers: Map<String, Provider>, defaultProviderId: String? = null, separator: String = ":", languageModelMiddleware: List<LanguageModelMiddleware> = emptyList()) : Provider

ProviderToolFactory

class ProviderToolFactory<TInput, TContext>(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, defaultDescription: String = "Provider tool ")

ProviderToolFactoryOptions

class ProviderToolFactoryOptions<TInput, TOutput, TContext>

ProviderToolFactoryOptionsBuilder

class ProviderToolFactoryOptionsBuilder<TInput, TOutput, TContext>

ProviderToolFactoryWithOutputSchema

class ProviderToolFactoryWithOutputSchema<TInput, TOutput, TContext>(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, outputSerializer: KSerializer<TOutput>, outputSchema: Schema<TOutput>, supportsDeferredResults: Boolean = false, defaultDescription: String = "Provider tool ")

ProviderTools

object ProviderTools

PruneEmptyMessages

enum PruneEmptyMessages : Enum<PruneEmptyMessages>

PruneReasoning

enum PruneReasoning : Enum<PruneReasoning>

PruneToolCallRule

data class PruneToolCallRule(val type: PruneToolCallRuleType, val tools: Set<String>? = null)

PruneToolCallRuleType

sealed class PruneToolCallRuleType

PruneToolCalls

sealed class PruneToolCalls

ReadResourceResult

@Serializable

class ReadResourceResult(val contents: List<JsonObject>, val meta: JsonObject? = null)

RedactionOptions

class RedactionOptions

RedactionOptionsBuilder

class RedactionOptionsBuilder

Redactor

interface Redactor

RerankedItem

class RerankedItem<T>(val value: T, val score: Float, val index: Int)

Reranking

object Reranking

RerankingModel

interface RerankingModel

RerankingModelResult

class RerankingModelResult(val results: List<RerankedItem<String>>, val usage: Usage = Usage(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

RerankingParams

class RerankingParams

RerankingParamsBuilder

class RerankingParamsBuilder

RerankResult

class RerankResult<T>(val results: List<RerankedItem<T>>, val originalDocuments: List<T> = emptyList(), val usage: Usage = Usage(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

ResponseFormat

@Serializable

sealed interface ResponseFormat

Wire-level constraint on what shape the model is allowed to emit. Mirrors v6's responseFormat (per call-settings.ts:103-128 → historical parity gap #20). Distinct from Output — Output is the post-decode wrapper that turns text into typed values; ResponseFormat is what the provider sees at call time.

RetryAttemptDetail

class RetryAttemptDetail(val attempt: Int, val error: Throwable, val retryable: Boolean, val delayMs: Long?)

RetryDelayGenerator

fun interface RetryDelayGenerator

RetryError

class RetryError(message: String, val reason: RetryErrorReason, val errors: List<Throwable>, val attempts: List<RetryAttemptDetail> = errors.mapIndexed { index, error -> RetryAttemptDetail( attempt = index, error = error, retryable = index < errors.lastIndex, delayMs = null, ) }) : AiSdkException

RetryErrorReason

enum RetryErrorReason : Enum<RetryErrorReason>

RetryPolicy

class RetryPolicy

RetryPolicyBuilder

class RetryPolicyBuilder

Schema

class Schema<T>(val jsonSchema: JsonElement, val validate: (JsonElement) -> T? = null)

Schemas

object Schemas

SpeechGeneration

object SpeechGeneration

SpeechGenerationParams

class SpeechGenerationParams

SpeechGenerationParamsBuilder

class SpeechGenerationParamsBuilder

SpeechModel

interface SpeechModel

SpeechModelResult

class SpeechModelResult(val audio: GeneratedFile?, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

SseMCPTransport

class SseMCPTransport(client: HttpClient, url: String, headers: Map<String, String> = emptyMap(), authProvider: OAuthClientProvider? = null, engineContext: CoroutineContext = Dispatchers.Default) : MCPTransport

StdioConfig

@Serializable

class StdioConfig

StdioConfigBuilder

class StdioConfigBuilder

StepResult

class StepResult

Snapshot of one completed loop step — surfaced to AgentEvent.StepFinished and accumulated in the loop state for PrepareStepScope.steps.

StepSettings

class StepSettings<TContext>

Returned from prepareStep. Any non-null field overrides the agent default / prepareCall value for this step only.

StepSettingsBuilder

class StepSettingsBuilder<TContext>

StopCondition

fun interface StopCondition

StreamEvent

@Serializable

sealed class StreamEvent

Sealed event stream emitted by LanguageModel.stream and surfaced to application code via Agent.stream. Mirrors the v6 stream-part taxonomy (per packages/ai/src/generate-text/stream-text-result.ts in vercel/ai) adapted to Kotlin sealed classes for exhaustive when.

StreamingTool

abstract class StreamingTool<TInput, TOutput, TContext> : Tool<TInput, TOutput, TContext>

StreamObjectFinish

class StreamObjectFinish<TOutput>(val value: TOutput, val usage: Usage, val finishReason: FinishReason, val warnings: List<CallWarning>, val response: LanguageModelResponseMetadata)

StreamObjectResult

class StreamObjectResult<TOutput>

StreamTextResult

class StreamTextResult(sourceStream: Flow<StreamEvent>, val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), initialResponse: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

Streaming generation result — memoised replay. A terminal upstream run is collected at most once; later collectors replay the captured events. If every collector leaves before the upstream reaches a terminal state, that producer is cancelled, its partial buffer is discarded, and a later collector starts a fresh upstream run. To preserve full replay for a collector that attaches after the first event, the result keeps the terminal stream event sequence in memory for the result lifetime. Hosts that need minimum peak memory for a guaranteed single-consumer path can collect the model stream directly instead of using this replaying result surface.

StructuredObject

class StructuredObject<RESULT, INPUT>(options: StructuredObjectOptions<RESULT, INPUT>)

StructuredObjectFinish

class StructuredObjectFinish<RESULT>

StructuredObjectGenerator

class StructuredObjectGenerator<RESULT>(model: LanguageModel, schema: Schema<RESULT>, config: CallConfig = CallConfig(), schemaName: String = "object", schemaDescription: String? = null)

Wires a LanguageModel to the structured-object machinery: constrains the model to emit JSON for schema, streams its text deltas into StructuredObject.phases (the shared parse/validate loop), and surfaces typed partials/value. Mirrors TextGenerator — a PascalCase class, not a camelCase top-level generateObject/streamObject.

StructuredObjectOptions

class StructuredObjectOptions<RESULT, INPUT>

StructuredObjectOptionsBuilder

class StructuredObjectOptionsBuilder<RESULT, INPUT>

StructuredObjectPhase

sealed class StructuredObjectPhase<out RESULT>

StructuredObjectRequest

class StructuredObjectRequest<INPUT>

StructuredObjectRequestBuilder

class StructuredObjectRequestBuilder<INPUT>

StructuredObjectTransport

interface StructuredObjectTransport<INPUT>

Telemetry

interface Telemetry

TelemetryActiveSpan

interface TelemetryActiveSpan

TelemetryCall

class TelemetryCall(val callId: String, val agentId: String, val agentVersion: String? = null, val modelId: String? = null, val functionId: String? = null)

Correlation envelope for one agent invocation (one generate/stream call). Every Telemetry event of that invocation carries the same callId, so an integration can reconstruct per-call traces even when a single agent instance serves concurrent calls. agentId/agentVersion mirror Agent.id/Agent.version (parity gap #33: "useful for telemetry"); functionId comes from TelemetrySettings.functionId.

TelemetryRegistry

class TelemetryRegistry(seed: List<Telemetry> = emptyList())

Ordered registry of Telemetry integrations, keyed by Telemetry.name (re-register replaces, keeping the original position).

TelemetrySettings

class TelemetrySettings

TelemetrySettingsBuilder

class TelemetrySettingsBuilder

TelemetrySpanStatus

sealed class TelemetrySpanStatus

TelemetryTracer

interface TelemetryTracer

TextGenerationRequest

class TextGenerationRequest

TextGenerationRequestBuilder

class TextGenerationRequestBuilder

TextGenerator

class TextGenerator @JvmOverloads constructor(model: LanguageModel, config: CallConfig = CallConfig())

High-level text generation facade for a single LanguageModel.

Tool

abstract class Tool<TInput, TOutput, TContext>

ToolApprovalSignature

object ToolApprovalSignature

value class ToolCallId(val value: String)

ToolCallNotFoundForApprovalError

class ToolCallNotFoundForApprovalError(val toolCallId: String, val approvalId: String) : AiSdkException

ToolCallRepairError

class ToolCallRepairError(val originalError: Throwable, cause: Throwable, message: String = "Error repairing tool call: ") : AiSdkException

ToolCallRepairFunction

typealias ToolCallRepairFunction<TContext> = suspend (failedCall: ContentPart.ToolCall, error: Throwable, messages: List<ModelMessage>, tools: ToolSet<TContext>) -> ContentPart.ToolCall?

Callback invoked when a tool call's JSON arguments fail to decode. Return a corrected ContentPart.ToolCall to retry, or null to give up. Mirrors v6's experimental_repairToolCall.

ToolChoice

@Serializable

sealed class ToolChoice

Whether the LLM should call a tool, no tool, a specific tool, etc.

ToolExecutionContext

class ToolExecutionContext<TContext>(val context: TContext?, val abortSignal: AbortSignal, val stepNumber: Int, val messages: List<ModelMessage>, val toolCallId: String, val writer: ToolStreamWriter = NoopToolStreamWriter)

What Tool.execute receives as its context. Holds the typed application context, abort signal, step number, running message list, and a writer for custom events.

ToolExecutionPolicy

class ToolExecutionPolicy

Resource limits for executing tool calls emitted by one agent step.

ToolExecutionPolicyBuilder

class ToolExecutionPolicyBuilder

ToolLoopAgent

abstract class ToolLoopAgent<TContext, TOutput>(settings: AgentSettings<TContext> = AgentSettings(), val model: LanguageModel = settings.model ?: throw InvalidArgumentError("model", "ToolLoopAgent requires model via parameter or settings"), val instructions: String = settings.instructions ?: throw InvalidArgumentError( "instructions", "ToolLoopAgent requires instructions via parameter or settings", ), val tools: ToolSet<TContext> = settings.tools ?: throw InvalidArgumentError("tools", "ToolLoopAgent requires tools via parameter or settings"), val output: Output<TOutput>? = settings.output as Output<TOutput>?, val stopWhen: StopCondition = settings.stopWhen ?: StepCountIs(20)) : Agent<TContext, TOutput>

Abstract base Agent implementation — the canonical v6 ToolLoopAgent. Extend it; do not instantiate it. A concrete agent subclasses this (e.g. class MyAgent(...) : ToolLoopAgent<C, O>(...)) so the agent's identity, tools, lifecycle overrides, and DI live in one named type — never a bare ToolLoopAgent(...) held as a field.

ToolLoopAgentAction

sealed class ToolLoopAgentAction<out TContext>

Actions the host dispatches to drive the agent. Mirrors the Action sealed type a Compose ViewModel exposes — the agent is the "model" of an MVI loop.

ToolLoopAgentState

data class ToolLoopAgentState(val messages: List<ModelMessage> = emptyList(), val streamingAssistantText: String = "", val currentToolCalls: List<ContentPart.ToolCall> = emptyList(), val pendingApprovals: List<PendingApproval> = emptyList(), val phase: ToolLoopAgentState.Phase = Phase.Idle, val totalSteps: Int = 0, val lastFinishReason: FinishReason? = null)

value class ToolName(val value: String)

ToolNameMapping

data class ToolNameMapping(customToolNameToProviderToolName: Map<String, String>, providerToolNameToCustomToolName: Map<String, String>)

ToolPredicateOptions

class ToolPredicateOptions<TContext>

Options bag passed to predicate callbacks (Tool.needsApproval, Tool.toModelOutput).

ToolPredicateOptionsBuilder

class ToolPredicateOptionsBuilder<TContext>

ToolResult

sealed class ToolResult<out O>

Wrapper emitted by Tool.execute — currently only Success; sealed for future variants.

ToolResultOutput

@Serializable

sealed class ToolResultOutput

Structured return type for Tool.toModelOutput.

ToolResultOutputs

object ToolResultOutputs

ToolSchema

class ToolSchema(val name: String, val description: String, val strict: Boolean? = null, val inputExamples: List<String> = emptyList(), val metadata: Map<String, JsonElement> = emptyMap(), val providerExecuted: Boolean = false, val providerOptions: ProviderOptions = ProviderOptions.None)

LLM-visible metadata for a Tool. Separates schema from executor.

ToolSchemaOptions

class ToolSchemaOptions

Bundles selected ToolSchema flags for factory functions.

ToolSchemaOptionsBuilder

class ToolSchemaOptionsBuilder

ToolSet

class ToolSet<TContext>(val byName: Map<String, Tool<*, *, TContext>>)

Erased map of tools indexed by name. Application code constructs via the ToolSet factory.

ToolSetBuilder

class ToolSetBuilder<TContext>

ToolStreamWriter

interface ToolStreamWriter

Lets a tool's executor write custom events into the agent's active output stream. Distinct from the streaming-tool mechanism — pushes arbitrary StreamEvents.

TooManyEmbeddingValuesForCallError

class TooManyEmbeddingValuesForCallError(val provider: String, val modelId: String, val maxEmbeddingsPerCall: Int, val values: List<Any?>) : AiSdkException

TranscribeResult

class TranscribeResult(val text: String, val segments: List<TranscriptSegment> = emptyList(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val responses: List<LanguageModelResponseMetadata> = listOf(response), val language: String? = null, val durationInSeconds: Float? = null)

Transcription

object Transcription

TranscriptionModel

interface TranscriptionModel

TranscriptionModelResult

class TranscriptionModelResult(val text: String?, val segments: List<TranscriptSegment> = emptyList(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None, val language: String? = null, val durationInSeconds: Float? = null)

TranscriptionParams

class TranscriptionParams

TranscriptionParamsBuilder

class TranscriptionParamsBuilder

TranscriptSegment

class TranscriptSegment(val text: String, val startSeconds: Float? = null, val endSeconds: Float? = null)

TypeValidationContext

class TypeValidationContext(val field: String? = null, val entityName: String? = null, val entityId: String? = null)

TypeValidationError

class TypeValidationError(val value: JsonElement?, cause: Throwable, val context: TypeValidationContext? = null) : AiSdkException

UiMessageStreamError

class UiMessageStreamError(message: String, cause: Throwable? = null) : AiSdkException

UnauthorizedError

class UnauthorizedError(message: String = "Unauthorized") : AiSdkException

UnsupportedFunctionalityError

class UnsupportedFunctionalityError(val functionality: String, message: String = "'") : AiSdkException

UnsupportedModelVersionError

class UnsupportedModelVersionError(modelId: String, version: String) : AiSdkException

Usage

@Serializable

class Usage(val inputTokens: Usage.InputTokenBreakdown = InputTokenBreakdown(), val outputTokens: Usage.OutputTokenBreakdown = OutputTokenBreakdown(), val raw: JsonElement? = null)

Token-usage tracking, surfaced on completed steps and final results. Per historical parity gap #19, the shape mirrors v6's rich tree — input tokens split into noCache / cacheRead / cacheWrite and output tokens split into text / reasoning plus a raw slot for provider-specific payloads.

UsageArithmetic

object UsageArithmetic

Arithmetic over Usage. The + operator lives here as a member-extension (decision-C: no loose top-level funs). Call sites bring it into scope with with(UsageArithmetic) { a + b } or a member import.

UseCompletionOptions

class UseCompletionOptions

UseCompletionOptionsBuilder

class UseCompletionOptionsBuilder

ValidationResult

sealed class ValidationResult<out T>

VideoGeneration

object VideoGeneration

VideoGenerationParams

class VideoGenerationParams

VideoGenerationParamsBuilder

class VideoGenerationParamsBuilder

VideoModel

interface VideoModel

VideoModelResult

class VideoModelResult(val videos: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: ProviderMetadata = ProviderMetadata.None)

WireDecodeException

class WireDecodeException(val provider: String, val operation: String, val path: String, message: String, val value: JsonElement? = null, cause: Throwable? = null) : AiSdkException

Properties

AbortSignalNever

val AbortSignalNever: AbortSignal

A signal that is never aborted. Useful as a default.

AI_GATEWAY_DEFAULT_BASE_URL

const val AI_GATEWAY_DEFAULT_BASE_URL: String

AI_GATEWAY_PROTOCOL_VERSION

const val AI_GATEWAY_PROTOCOL_VERSION: String

AiSdkDefaultRedactor

val AiSdkDefaultRedactor: Redactor

gateway

val gateway: GatewayProvider

GATEWAY_AUTH_METHOD_HEADER

const val GATEWAY_AUTH_METHOD_HEADER: String

globalTelemetry

val globalTelemetry: TelemetryRegistry

Global registry — upstream v7 registerTelemetry: register once at startup, all calls emit.

LATEST_PROTOCOL_VERSION

const val LATEST_PROTOCOL_VERSION: String

MCP_PACKAGE_VERSION

const val MCP_PACKAGE_VERSION: String

metadata

val ContentPart.metadata: ProviderMetadata

val StreamEvent.metadata: ProviderMetadata

SUPPORTED_PROTOCOL_VERSIONS

val SUPPORTED_PROTOCOL_VERSIONS: List<String>

Functions

AbortSignalFromJob

fun AbortSignalFromJob(job: Job): AbortSignal

Bind an abort signal to a Job so the signal fires when the job completes (cancelled or otherwise). Lets a parent scope's lifetime automatically cancel anything observing the signal.

AgentSettings

fun <TContext> AgentSettings(block: AgentSettingsBuilder<TContext>.() -> Unit = {}): AgentSettings<TContext>

AllOf

fun AllOf(vararg conditions: StopCondition): StopCondition

Stop only when all conditions report done.

AnyOf

fun AnyOf(vararg conditions: StopCondition): StopCondition

Stop when any of conditions reports done. v6's array-of-conditions shape.

AssistantMessage

fun AssistantMessage(text: String): ModelMessage

AuthOptions

fun AuthOptions(block: AuthOptionsBuilder.() -> Unit = {}): AuthOptions

CallCompletionApiOptions

fun CallCompletionApiOptions(block: CallCompletionApiOptionsBuilder.() -> Unit = {}): CallCompletionApiOptions

CallConfig

fun CallConfig(block: CallConfigBuilder.() -> Unit = {}): CallConfig

CallSettings

fun CallSettings(block: CallSettingsBuilder.() -> Unit = {}): CallSettings

CombineAbortSignals

fun CombineAbortSignals(vararg signals: AbortSignal): AbortSignal

CompletionRequest

fun CompletionRequest(block: CompletionRequestBuilder.() -> Unit = {}): CompletionRequest

CompletionRequestOptions

fun CompletionRequestOptions(block: CompletionRequestOptionsBuilder.() -> Unit = {}): CompletionRequestOptions

Configuration

fun Configuration(block: ConfigurationBuilder.() -> Unit = {}): Configuration

CreateGatewayHttpProvider

fun CreateGatewayHttpProvider(client: HttpClient, settings: GatewayProviderSettings = GatewayProviderSettings(), json: Json = aiSdkJson): GatewayProvider

CreateMCPClient

suspend fun CreateMCPClient(config: MCPClientConfig): MCPClient

CreateMcpTransport

fun CreateMcpTransport(client: HttpClient, config: MCPTransportConfig): MCPTransport

CustomProvider

fun CustomProvider(block: CustomProviderBuilder.() -> Unit): CustomProvider

DefaultEmbeddingSettingsMiddleware

fun DefaultEmbeddingSettingsMiddleware(maxEmbeddingsPerCall: Int? = null, truncate: Boolean? = null, providerOptions: ProviderOptions = ProviderOptions.None, headers: Map<String, String> = emptyMap()): EmbeddingModelMiddleware

DevToolsMiddleware

@JvmOverloads

fun DevToolsMiddleware(recorder: DevToolsRecorder = InMemoryDevToolsRecorder(), environment: String = "development", runId: String = IdGenerator.generate(prefix = "run"), idGenerator: () -> String = { IdGenerator.generate(prefix = "step") }): LanguageModelMiddleware

DynamicTool

@JvmOverloads

fun <TContext> DynamicTool(name: String, description: String, inputSchemaJson: String = "{}", metadata: Map<String, JsonElement> = emptyMap(), toModelOutput: (JsonElement, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, executor: suspend ToolExecutionContext<TContext>.(JsonElement) -> JsonElement): Tool<JsonElement, JsonElement, TContext>

Runtime-typed tool — inputs and outputs are raw JsonElement. Schema is supplied as a JSON string and stored in ToolSchema.metadata under "inputSchema".

ElicitationCapability

fun ElicitationCapability(block: ElicitationCapabilityBuilder.() -> Unit = {}): ElicitationCapability

EmbeddingModelCallParams

fun EmbeddingModelCallParams(block: EmbeddingModelCallParamsBuilder.() -> Unit): EmbeddingModelCallParams

ExecuteTool

fun <TInput, TOutput, TContext> ExecuteTool(tool: Tool<TInput, TOutput, TContext>, input: TInput, options: ToolExecutionContext<TContext>): Flow<ExecuteToolResult<TOutput>>

Execute a tool outside the agent loop with one-step lookahead semantics.

Experimental_CreateMCPClient

suspend fun Experimental_CreateMCPClient(config: MCPClientConfig): MCPClient

Gateway

fun Gateway(settings: GatewayProviderSettings = GatewayProviderSettings()): GatewayProvider

Creates a Vercel AI Gateway provider.

GatewayGenerationInfoParams

fun GatewayGenerationInfoParams(block: GatewayGenerationInfoParamsBuilder.() -> Unit = {}): GatewayGenerationInfoParams

GatewayProvider

fun GatewayProvider(settings: GatewayProviderSettings = GatewayProviderSettings()): GatewayProvider

GatewayProviderSettings

fun GatewayProviderSettings(block: GatewayProviderSettingsBuilder.() -> Unit = {}): GatewayProviderSettings

GatewaySpendReportParams

fun GatewaySpendReportParams(block: GatewaySpendReportParamsBuilder.() -> Unit = {}): GatewaySpendReportParams

GeneratedFile

@JvmOverloads

fun GeneratedFile(data: FileData, mediaType: String = data.mediaType ?: "application/octet-stream", filename: String? = data.filename, providerMetadata: ProviderMetadata = ProviderMetadata.None): GeneratedFile

HasToolCall

fun HasToolCall(toolName: String): StopCondition

Stop the moment the named tool is called in any step.

IdGenerator

fun IdGenerator(block: IdGeneratorBuilder.() -> Unit = {}): IdGenerator

ImageGenerationFile

fun ImageGenerationFile(data: FileData): ImageGenerationFile

ImageGenerationParams

fun ImageGenerationParams(block: ImageGenerationParamsBuilder.() -> Unit = {}): ImageGenerationParams

LanguageModelCallParams

fun LanguageModelCallParams(block: LanguageModelCallParamsBuilder.() -> Unit): LanguageModelCallParams

MCPClientConfig

fun MCPClientConfig(block: MCPClientConfigBuilder.() -> Unit = {}): MCPClientConfig

MCPReconnectionOptions

fun MCPReconnectionOptions(block: MCPReconnectionOptionsBuilder.() -> Unit = {}): MCPReconnectionOptions

MCPRequestOptions

fun MCPRequestOptions(block: MCPRequestOptionsBuilder.() -> Unit = {}): MCPRequestOptions

MCPTransportConfig

fun MCPTransportConfig(block: MCPTransportConfigBuilder.() -> Unit = {}): MCPTransportConfig

ModelRef

fun ModelRef(value: String): ModelRef

fun ModelRef(providerId: ProviderId, modelId: ModelId): ModelRef

fun ModelRef(providerId: String, modelId: String): ModelRef

ModelRepromptRepair

fun <TContext> ModelRepromptRepair(model: LanguageModel): ToolCallRepairFunction<TContext>

Stock self-healing repair: re-prompt the model with the tool's JSON schema + the failed args + the parse error, asking for corrected JSON. If the second response parses cleanly, return a ContentPart.ToolCall with the corrected input; otherwise return null (the agent loop surfaces StreamEvent.ToolError).

OAuthClientInformation

fun OAuthClientInformation(block: OAuthClientInformationBuilder.() -> Unit = {}): OAuthClientInformation

OAuthClientMetadata

fun OAuthClientMetadata(block: OAuthClientMetadataBuilder.() -> Unit = {}): OAuthClientMetadata

OutputArray

fun <T> OutputArray(elementSerializer: KSerializer<T>, name: String = elementSerializer.descriptor.serialName.substringAfterLast('.') + "[]", description: String? = null): Output<List<T>>

OutputChoice

fun OutputChoice(options: Iterable<String>, name: String = "choice", description: String? = null): Output<String>

fun OutputChoice(vararg options: String, name: String = "choice", description: String? = null): Output<String>

fun <T> OutputChoice(options: Iterable<T>, encode: (T) -> String, decodeChoice: (String) -> T, name: String = "choice", description: String? = null): Output<T>

OutputJson

fun OutputJson(name: String = "json", description: String? = null): Output<JsonElement>

OutputObj

fun <T> OutputObj(serializer: KSerializer<T>, name: String = serializer.descriptor.serialName.substringAfterLast('.'), description: String? = null): Output<T>

Provider

@JvmOverloads

fun Provider(providerId: String, languageModels: Map<String, LanguageModel> = emptyMap(), embeddingModels: Map<String, EmbeddingModel> = emptyMap(), imageModels: Map<String, ImageModel> = emptyMap(), speechModels: Map<String, SpeechModel> = emptyMap(), transcriptionModels: Map<String, TranscriptionModel> = emptyMap(), rerankingModels: Map<String, RerankingModel> = emptyMap(), videoModels: Map<String, VideoModel> = emptyMap(), fallbackProvider: Provider? = null): Provider

ProviderExecutedTool

fun <TInput, TOutput, TContext> ProviderExecutedTool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, metadata: Map<String, JsonElement> = emptyMap()): Tool<TInput, TOutput, TContext>

Provider-executed tool: advertises itself to the model but has no local executor.

ProviderMiddleware

fun ProviderMiddleware(block: ProviderMiddlewareBuilder.() -> Unit = {}): ProviderMiddleware

ProviderToolFactoryOptions

fun <TInput, TOutput, TContext> ProviderToolFactoryOptions(block: ProviderToolFactoryOptionsBuilder<TInput, TOutput, TContext>.() -> Unit = {}): ProviderToolFactoryOptions<TInput, TOutput, TContext>

RedactionOptions

fun RedactionOptions(block: RedactionOptionsBuilder.() -> Unit = {}): RedactionOptions

RepeatedToolCallLoop

fun RepeatedToolCallLoop(n: Int): StopCondition

Stop when the model has emitted the same (toolName, input) tuple n consecutive steps in a row — i.e. the loop is spinning on a tool whose result didn't change the model's behavior. Documented anti-pattern for small / on-device models that can't reason their way out of an unhelpful tool result; surfaced as a hard stop so the host renders the trapped state instead of looping until the step cap.

RerankingParams

fun RerankingParams(block: RerankingParamsBuilder.() -> Unit = {}): RerankingParams

RetryPolicy

fun RetryPolicy(block: RetryPolicyBuilder.() -> Unit = {}): RetryPolicy

SimulateReadableStream

fun <T> SimulateReadableStream(chunks: Iterable<T>, delayMillis: Long = 0): Flow<T>

Creates a cold Flow that emits chunks in order with delayMillis between chunks. The first chunk is emitted immediately; the delay applies only between consecutive chunks.

SmoothStream

fun SmoothStream(upstream: Flow<StreamEvent>, delayMs: Long = 10, chunkBy: ChunkBy = ChunkBy.Word): Flow<StreamEvent>

SpeechGenerationParams

fun SpeechGenerationParams(block: SpeechGenerationParamsBuilder.() -> Unit = {}): SpeechGenerationParams

StdioConfig

fun StdioConfig(block: StdioConfigBuilder.() -> Unit = {}): StdioConfig

StepCountIs

fun StepCountIs(n: Int): StopCondition

Stop after n completed steps. v6's default is 20 if stopWhen omitted.

StepSettings

fun <TContext> StepSettings(block: StepSettingsBuilder<TContext>.() -> Unit = {}): StepSettings<TContext>

StreamingTool

inline fun <TInput, TOutput, TContext> StreamingTool(name: String, description: String, noinline needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, noinline toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, schemaOptions: ToolSchemaOptions = ToolSchemaOptions {}, inputExamples: List<String> = emptyList(), noinline onInputStart: suspend (streamingId: String) -> Unit? = null, noinline onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, noinline onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerOptions: ProviderOptions = ProviderOptions.None, noinline executor: ToolExecutionContext<TContext>.(TInput) -> Flow<TOutput>): Tool<TInput, TOutput, TContext>

Reified streaming factory — infers serializers from type parameters.

@JvmOverloads

fun <TInput, TOutput, TContext> StreamingTool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, schemaOptions: ToolSchemaOptions = ToolSchemaOptions {}, inputExamples: List<String> = emptyList(), onInputStart: suspend (streamingId: String) -> Unit? = null, onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerOptions: ProviderOptions = ProviderOptions.None, executor: ToolExecutionContext<TContext>.(TInput) -> Flow<TOutput>): Tool<TInput, TOutput, TContext>

Streaming Tool factory — executor returns Flow, each emission is a value.

StreamObjectResult

fun <TOutput> StreamObjectResult(model: LanguageModel, output: Output<TOutput>, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: ProviderOptions = ProviderOptions.None, abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text, repairText: (String) -> String?? = null): StreamObjectResult<TOutput>

StructuredObjectOptions

fun <RESULT, INPUT> StructuredObjectOptions(block: StructuredObjectOptionsBuilder<RESULT, INPUT>.() -> Unit = {}): StructuredObjectOptions<RESULT, INPUT>

StructuredObjectRequest

fun <INPUT> StructuredObjectRequest(block: StructuredObjectRequestBuilder<INPUT>.() -> Unit = {}): StructuredObjectRequest<INPUT>

SystemMessage

fun SystemMessage(text: String): ModelMessage

TelemetrySettings

fun TelemetrySettings(block: TelemetrySettingsBuilder.() -> Unit = {}): TelemetrySettings

TextGenerationRequest

fun TextGenerationRequest(block: TextGenerationRequestBuilder.() -> Unit = {}): TextGenerationRequest

Tool

inline fun <TInput, TOutput, TContext> Tool(name: String, description: String, noinline needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, noinline toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, schemaOptions: ToolSchemaOptions = ToolSchemaOptions {}, inputExamples: List<String> = emptyList(), noinline onInputStart: suspend (streamingId: String) -> Unit? = null, noinline onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, noinline onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerOptions: ProviderOptions = ProviderOptions.None, noinline executor: suspend ToolExecutionContext<TContext>.(TInput) -> TOutput): Tool<TInput, TOutput, TContext>

Reified convenience overload — infers serializers from type parameters.

@JvmOverloads

fun <TInput, TOutput, TContext> Tool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, schemaOptions: ToolSchemaOptions = ToolSchemaOptions {}, inputExamples: List<String> = emptyList(), onInputStart: suspend (streamingId: String) -> Unit? = null, onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerOptions: ProviderOptions = ProviderOptions.None, executor: suspend ToolExecutionContext<TContext>.(TInput) -> TOutput): Tool<TInput, TOutput, TContext>

Single-value Tool factory — executor is a suspend function returning TOutput.

ToolApprovalResponseMessage

fun ToolApprovalResponseMessage(toolCallId: String, approved: Boolean, reason: String? = null, approvalId: String? = null): ModelMessage

ToolExecutionPolicy

fun ToolExecutionPolicy(block: ToolExecutionPolicyBuilder.() -> Unit = {}): ToolExecutionPolicy

ToolMessage

fun ToolMessage(toolCallId: String, toolName: String, output: JsonElement): ModelMessage

ToolNameMapping

fun ToolNameMapping(tools: List<LanguageModelTool> = emptyList(), providerToolNames: Map<String, String>, resolveProviderToolName: (LanguageModelTool) -> String?? = null): ToolNameMapping

ToolPredicateOptions

fun <TContext> ToolPredicateOptions(block: ToolPredicateOptionsBuilder<TContext>.() -> Unit = {}): ToolPredicateOptions<TContext>

ToolSchemaOptions

fun ToolSchemaOptions(block: ToolSchemaOptionsBuilder.() -> Unit = {}): ToolSchemaOptions

ToolSet

fun <TContext> ToolSet(vararg tools: Tool<*, *, TContext>): ToolSet<TContext>

Construct a ToolSet from individual tools. Throws on duplicate names.

TranscriptionParams

fun TranscriptionParams(block: TranscriptionParamsBuilder.() -> Unit = {}): TranscriptionParams

UseCompletionOptions

fun UseCompletionOptions(block: UseCompletionOptionsBuilder.() -> Unit = {}): UseCompletionOptions

UserMessage

fun UserMessage(text: String): ModelMessage

VideoGenerationParams

fun VideoGenerationParams(block: VideoGenerationParamsBuilder.() -> Unit = {}): VideoGenerationParams

WrapEmbeddingModel

fun WrapEmbeddingModel(model: EmbeddingModel, middlewares: List<EmbeddingModelMiddleware>): EmbeddingModel

WrapImageModel

fun WrapImageModel(model: ImageModel, middlewares: List<ImageModelMiddleware>): ImageModel

WrapLanguageModel

fun WrapLanguageModel(model: LanguageModel, middlewares: List<LanguageModelMiddleware>): LanguageModel

Compose middlewares over model into a new LanguageModel. Order: the first middleware in the list is the outermost wrapper — wrapGenerate runs first on the way in, last on the way out (innermost in the call stack, like Express middleware).

WrapProvider

fun WrapProvider(provider: Provider, middleware: ProviderMiddleware): Provider